<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2007 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.io;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import static com.google.common.base.Preconditions.checkArgument;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import static com.google.common.base.Preconditions.checkNotNull;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import com.google.common.annotations.Beta;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import com.google.common.base.Charsets;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.IOException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.InputStream;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.io.InputStreamReader;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.OutputStream;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.net.URL;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.nio.charset.Charset;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.List;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Provides utility methods for working with resources in the classpath.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Note that even though these methods use {@link URL} parameters, they<a name="line.35"></a>
<span class="sourceLineNo">036</span> * are usually not appropriate for HTTP or other non-classpath resources.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;All method parameters must be non-null unless documented otherwise.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @author Chris Nokleberg<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @author Ben Yu<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @since 1.0<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>@Beta<a name="line.44"></a>
<span class="sourceLineNo">045</span>public final class Resources {<a name="line.45"></a>
<span class="sourceLineNo">046</span>  private Resources() {}<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>  /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>   * Returns a factory that will supply instances of {@link InputStream} that<a name="line.49"></a>
<span class="sourceLineNo">050</span>   * read from the given URL.<a name="line.50"></a>
<span class="sourceLineNo">051</span>   *<a name="line.51"></a>
<span class="sourceLineNo">052</span>   * @param url the URL to read from<a name="line.52"></a>
<span class="sourceLineNo">053</span>   * @return the factory<a name="line.53"></a>
<span class="sourceLineNo">054</span>   */<a name="line.54"></a>
<span class="sourceLineNo">055</span>  public static InputSupplier&lt;InputStream&gt; newInputStreamSupplier(<a name="line.55"></a>
<span class="sourceLineNo">056</span>      final URL url) {<a name="line.56"></a>
<span class="sourceLineNo">057</span>    checkNotNull(url);<a name="line.57"></a>
<span class="sourceLineNo">058</span>    return new InputSupplier&lt;InputStream&gt;() {<a name="line.58"></a>
<span class="sourceLineNo">059</span>      @Override<a name="line.59"></a>
<span class="sourceLineNo">060</span>      public InputStream getInput() throws IOException {<a name="line.60"></a>
<span class="sourceLineNo">061</span>        return url.openStream();<a name="line.61"></a>
<span class="sourceLineNo">062</span>      }<a name="line.62"></a>
<span class="sourceLineNo">063</span>    };<a name="line.63"></a>
<span class="sourceLineNo">064</span>  }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>  /**<a name="line.66"></a>
<span class="sourceLineNo">067</span>   * Returns a factory that will supply instances of<a name="line.67"></a>
<span class="sourceLineNo">068</span>   * {@link InputStreamReader} that read a URL using the given character set.<a name="line.68"></a>
<span class="sourceLineNo">069</span>   *<a name="line.69"></a>
<span class="sourceLineNo">070</span>   * @param url the URL to read from<a name="line.70"></a>
<span class="sourceLineNo">071</span>   * @param charset the charset used to decode the input stream; see {@link<a name="line.71"></a>
<span class="sourceLineNo">072</span>   *     Charsets} for helpful predefined constants<a name="line.72"></a>
<span class="sourceLineNo">073</span>   * @return the factory<a name="line.73"></a>
<span class="sourceLineNo">074</span>   */<a name="line.74"></a>
<span class="sourceLineNo">075</span>  public static InputSupplier&lt;InputStreamReader&gt; newReaderSupplier(<a name="line.75"></a>
<span class="sourceLineNo">076</span>      URL url, Charset charset) {<a name="line.76"></a>
<span class="sourceLineNo">077</span>    return CharStreams.newReaderSupplier(newInputStreamSupplier(url), charset);<a name="line.77"></a>
<span class="sourceLineNo">078</span>  }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>  /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>   * Reads all bytes from a URL into a byte array.<a name="line.81"></a>
<span class="sourceLineNo">082</span>   *<a name="line.82"></a>
<span class="sourceLineNo">083</span>   * @param url the URL to read from<a name="line.83"></a>
<span class="sourceLineNo">084</span>   * @return a byte array containing all the bytes from the URL<a name="line.84"></a>
<span class="sourceLineNo">085</span>   * @throws IOException if an I/O error occurs<a name="line.85"></a>
<span class="sourceLineNo">086</span>   */<a name="line.86"></a>
<span class="sourceLineNo">087</span>  public static byte[] toByteArray(URL url) throws IOException {<a name="line.87"></a>
<span class="sourceLineNo">088</span>    return ByteStreams.toByteArray(newInputStreamSupplier(url));<a name="line.88"></a>
<span class="sourceLineNo">089</span>  }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span>  /**<a name="line.91"></a>
<span class="sourceLineNo">092</span>   * Reads all characters from a URL into a {@link String}, using the given<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * character set.<a name="line.93"></a>
<span class="sourceLineNo">094</span>   *<a name="line.94"></a>
<span class="sourceLineNo">095</span>   * @param url the URL to read from<a name="line.95"></a>
<span class="sourceLineNo">096</span>   * @param charset the charset used to decode the input stream; see {@link<a name="line.96"></a>
<span class="sourceLineNo">097</span>   *     Charsets} for helpful predefined constants<a name="line.97"></a>
<span class="sourceLineNo">098</span>   * @return a string containing all the characters from the URL<a name="line.98"></a>
<span class="sourceLineNo">099</span>   * @throws IOException if an I/O error occurs.<a name="line.99"></a>
<span class="sourceLineNo">100</span>   */<a name="line.100"></a>
<span class="sourceLineNo">101</span>  public static String toString(URL url, Charset charset) throws IOException {<a name="line.101"></a>
<span class="sourceLineNo">102</span>    return CharStreams.toString(newReaderSupplier(url, charset));<a name="line.102"></a>
<span class="sourceLineNo">103</span>  }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span>  /**<a name="line.105"></a>
<span class="sourceLineNo">106</span>   * Streams lines from a URL, stopping when our callback returns false, or we<a name="line.106"></a>
<span class="sourceLineNo">107</span>   * have read all of the lines.<a name="line.107"></a>
<span class="sourceLineNo">108</span>   *<a name="line.108"></a>
<span class="sourceLineNo">109</span>   * @param url the URL to read from<a name="line.109"></a>
<span class="sourceLineNo">110</span>   * @param charset the charset used to decode the input stream; see {@link<a name="line.110"></a>
<span class="sourceLineNo">111</span>   *     Charsets} for helpful predefined constants<a name="line.111"></a>
<span class="sourceLineNo">112</span>   * @param callback the LineProcessor to use to handle the lines<a name="line.112"></a>
<span class="sourceLineNo">113</span>   * @return the output of processing the lines<a name="line.113"></a>
<span class="sourceLineNo">114</span>   * @throws IOException if an I/O error occurs<a name="line.114"></a>
<span class="sourceLineNo">115</span>   */<a name="line.115"></a>
<span class="sourceLineNo">116</span>  public static &lt;T&gt; T readLines(URL url, Charset charset,<a name="line.116"></a>
<span class="sourceLineNo">117</span>      LineProcessor&lt;T&gt; callback) throws IOException {<a name="line.117"></a>
<span class="sourceLineNo">118</span>    return CharStreams.readLines(newReaderSupplier(url, charset), callback);<a name="line.118"></a>
<span class="sourceLineNo">119</span>  }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>  /**<a name="line.121"></a>
<span class="sourceLineNo">122</span>   * Reads all of the lines from a URL. The lines do not include<a name="line.122"></a>
<span class="sourceLineNo">123</span>   * line-termination characters, but do include other leading and trailing<a name="line.123"></a>
<span class="sourceLineNo">124</span>   * whitespace.<a name="line.124"></a>
<span class="sourceLineNo">125</span>   *<a name="line.125"></a>
<span class="sourceLineNo">126</span>   * @param url the URL to read from<a name="line.126"></a>
<span class="sourceLineNo">127</span>   * @param charset the charset used to decode the input stream; see {@link<a name="line.127"></a>
<span class="sourceLineNo">128</span>   *     Charsets} for helpful predefined constants<a name="line.128"></a>
<span class="sourceLineNo">129</span>   * @return a mutable {@link List} containing all the lines<a name="line.129"></a>
<span class="sourceLineNo">130</span>   * @throws IOException if an I/O error occurs<a name="line.130"></a>
<span class="sourceLineNo">131</span>   */<a name="line.131"></a>
<span class="sourceLineNo">132</span>  public static List&lt;String&gt; readLines(URL url, Charset charset)<a name="line.132"></a>
<span class="sourceLineNo">133</span>      throws IOException {<a name="line.133"></a>
<span class="sourceLineNo">134</span>    return CharStreams.readLines(newReaderSupplier(url, charset));<a name="line.134"></a>
<span class="sourceLineNo">135</span>  }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>  /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>   * Copies all bytes from a URL to an output stream.<a name="line.138"></a>
<span class="sourceLineNo">139</span>   *<a name="line.139"></a>
<span class="sourceLineNo">140</span>   * @param from the URL to read from<a name="line.140"></a>
<span class="sourceLineNo">141</span>   * @param to the output stream<a name="line.141"></a>
<span class="sourceLineNo">142</span>   * @throws IOException if an I/O error occurs<a name="line.142"></a>
<span class="sourceLineNo">143</span>   */<a name="line.143"></a>
<span class="sourceLineNo">144</span>  public static void copy(URL from, OutputStream to) throws IOException {<a name="line.144"></a>
<span class="sourceLineNo">145</span>    ByteStreams.copy(newInputStreamSupplier(from), to);<a name="line.145"></a>
<span class="sourceLineNo">146</span>  }<a name="line.146"></a>
<span class="sourceLineNo">147</span>  <a name="line.147"></a>
<span class="sourceLineNo">148</span>  /**<a name="line.148"></a>
<span class="sourceLineNo">149</span>   * Returns a {@code URL} pointing to {@code resourceName} if the resource is<a name="line.149"></a>
<span class="sourceLineNo">150</span>   * found in the class path. {@code Resources.class.getClassLoader()} is used<a name="line.150"></a>
<span class="sourceLineNo">151</span>   * to locate the resource.<a name="line.151"></a>
<span class="sourceLineNo">152</span>   * <a name="line.152"></a>
<span class="sourceLineNo">153</span>   * @throws IllegalArgumentException if resource is not found<a name="line.153"></a>
<span class="sourceLineNo">154</span>   */<a name="line.154"></a>
<span class="sourceLineNo">155</span>  public static URL getResource(String resourceName) {<a name="line.155"></a>
<span class="sourceLineNo">156</span>    URL url = Resources.class.getClassLoader().getResource(resourceName);<a name="line.156"></a>
<span class="sourceLineNo">157</span>    checkArgument(url != null, "resource %s not found.", resourceName);<a name="line.157"></a>
<span class="sourceLineNo">158</span>    return url;<a name="line.158"></a>
<span class="sourceLineNo">159</span>  }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>  /**<a name="line.161"></a>
<span class="sourceLineNo">162</span>   * Returns a {@code URL} pointing to {@code resourceName} that is relative to<a name="line.162"></a>
<span class="sourceLineNo">163</span>   * {@code contextClass}, if the resource is found in the class path. <a name="line.163"></a>
<span class="sourceLineNo">164</span>   * <a name="line.164"></a>
<span class="sourceLineNo">165</span>   * @throws IllegalArgumentException if resource is not found<a name="line.165"></a>
<span class="sourceLineNo">166</span>   */<a name="line.166"></a>
<span class="sourceLineNo">167</span>  public static URL getResource(Class&lt;?&gt; contextClass, String resourceName) {<a name="line.167"></a>
<span class="sourceLineNo">168</span>    URL url = contextClass.getResource(resourceName);<a name="line.168"></a>
<span class="sourceLineNo">169</span>    checkArgument(url != null, "resource %s relative to %s not found.",<a name="line.169"></a>
<span class="sourceLineNo">170</span>        resourceName, contextClass.getName());<a name="line.170"></a>
<span class="sourceLineNo">171</span>    return url;<a name="line.171"></a>
<span class="sourceLineNo">172</span>  }<a name="line.172"></a>
<span class="sourceLineNo">173</span>}<a name="line.173"></a>




























































</pre>
</div>
</body>
</html>
